/**
 * Software License, Version 1.0
 *
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 *
 *
 *Redistribution and use in source and binary forms, with or without
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For
 * further information contact the Community Grids Lab at
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and
 * wherever such third-party acknowledgments normally appear.
 *
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering,
 * shall not be used to endorse or promote products derived from this software
 * without prior written permission from Indiana University.  For written
 * permission, please contact the Advanced Research and Technology Institute
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering,
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 *
 *
 * Indiana University provides no reassurances that the source code provided
 * does not infringe the patent or any other intellectual property rights of
 * any other entity.  Indiana University disclaims any liability to any
 * recipient for claims brought by any other entity based on infringement of
 * intellectual property rights or otherwise.
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS.
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS",
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsr.impl;



import cgl.narada.wsinfra.exception.DeploymentException;
import cgl.narada.wsinfra.wsr.storage.WsrGroupInfo;
import cgl.narada.wsinfra.wsr.storage.WsrGroupInfoStorageOperations;
import cgl.narada.wsinfra.wsr.storage.WsrProtocolStorageOperations;
import cgl.narada.wsinfra.wsr.storage.WsrStorageException;
import cgl.narada.wsinfra.wsr.storage.WsrStorageService;
import cgl.narada.wsinfra.wsr.storage.impl.WsrGroupTerminationInfoImpl;
import cgl.narada.wsinfra.wsr.storage.impl.WsrStorageWidgetImpl;


/**
 * @author 
 * $Created on February 16, 2005, 2:31 PM $
 * $Version 1.0
 */
public class WsrSourceGroupTerminationImpl {
	private WsrStorageService wsrStorageService;
    private WsrProtocolStorageOperations wsrProtocolStorageOperations;
    private WsrGroupInfoStorageOperations wsrGroupInfoStorageOperations;
    private WsrUtil wsrUtil;
    private String moduleName = "WsrSourceGroupTerminationImpl: ";

	private static final WsrSourceGroupTerminationImpl instance = 
                                                new WsrSourceGroupTerminationImpl();

	private WsrSourceGroupTerminationImpl() {
	 	wsrUtil = WsrUtil.getInstance();
	}

	public static WsrSourceGroupTerminationImpl getInstance() {
		return instance;
	}
	public void initialize(WsrStorageService wsrStorageService)
                throws DeploymentException {
		this.wsrStorageService = wsrStorageService;
		if (wsrStorageService == null) {
			throw new DeploymentException(moduleName+"StorageService is NULL!");
		}
		try {
			wsrProtocolStorageOperations =
				wsrStorageService.getWsrProtocolStorageOperations();
			wsrGroupInfoStorageOperations =
				wsrStorageService.getWsrGroupInfoStorageOperations();

		} catch (WsrStorageException wsrStorageException) {
			String reason = moduleName + "Problems initializing storage"+
			"services\n" + wsrStorageException.toString();
			throw new DeploymentException(reason);
		}

	}
	
	
	/* Check to see if the group needs to be terminated, and if so, proceed
	  to do that */
	  public void processGroupTermination(String groupId) 
	              throws WsrStorageException {
	      
	      WsrGroupInfo wsrGroupInfo = 
	                wsrGroupInfoStorageOperations.getGroupInfoUsingGroupId(groupId);
	      WsrGroupTerminationInfoImpl wsrGroupTerminationInfoImpl =
	                wsrProtocolStorageOperations.getGroupTerminationInfo(groupId);
	      
	      boolean isGroupExpired = false;
	      boolean isGroupMaxIdleDurationPassed = false;
	      boolean isMessageExpired = false;
	     
	      
	      while(!wsrGroupTerminationInfoImpl.isGroupClosed()){
	          // check all group closing parameters 
	          if(wsrGroupInfo.hasGroupExpiryTime()){
	              if(wsrUtil.isExpiryTimePassed(wsrGroupInfo.getGroupExpiryTime())){
	                  isGroupExpired = true;
	                  wsrGroupTerminationInfoImpl.setGroupExpiryTimePassed(true);
	                  continue;
	              }
	          }
	          if(wsrGroupInfo.hasGroupMaxIdleDuration()){
	              if(wsrUtil.isDurationPassed(wsrGroupInfo.getGroupMaxIdleDuration())){
	                  isGroupMaxIdleDurationPassed = true;
	                  wsrGroupTerminationInfoImpl.setGroupMaxIdleDurationPassed(
	                                                                          true);
	                  continue;
	              }
	          }
	          //check here is any unack message expired
	          long[] seqNums = 
	                  wsrProtocolStorageOperations.getUnacknowledgedSequenceNumbers
	                                                                      (groupId);
	          if(seqNums != null){
		          WsrStorageWidgetImpl[] wsrStorageWidgets =
		                  wsrProtocolStorageOperations.getStoredElements(groupId,
		                                                                       seqNums);
		          for(int count =0; count < wsrStorageWidgets.length; count++){
		              if(wsrUtil.isExpiryTimePassed(
		                             wsrStorageWidgets[count].getMessageExpiryTime())){
		                  isMessageExpired = true;
		                  wsrGroupTerminationInfoImpl.setMessageExpired(true);
		                  break;
		              }
		          }
		          if(isMessageExpired){
		              continue;
		          }
	          }
	          
	          break;
	      }
	      if(!wsrGroupTerminationInfoImpl.isGroupClosed()&&
	         !isGroupExpired && !isGroupMaxIdleDurationPassed && 
	         !isMessageExpired){
	          return;
	      }
	      //it will come here if groupid closed anyhow*/
	      // check whether we should remove it or not*/
	      //returns all the unack and unfaulted messages for the particular group
	      long[] stillToBeAcked = 
	         wsrProtocolStorageOperations.getUnacknowledgedSequenceNumbers(groupId);
	    
	      if (stillToBeAcked != null) {
	          wsrProtocolStorageOperations.storeGroupTerminationInfo
	                                                (wsrGroupTerminationInfoImpl);
	      /* There are still message numbers that need to acknowledged. Return.*/
	          return;
	      }
	    
	      /* Proceed to terminate Group*/
	      wsrGroupInfoStorageOperations.removeDestinationGroupIdPair(groupId);
	      wsrGroupInfoStorageOperations.deleteGroupInfo(groupId);
	      wsrProtocolStorageOperations.deleteGroupTerminationInfo(groupId);
	      long[] numbers = wsrProtocolStorageOperations.getSequenceNumbers(groupId);
	      WsrStorageWidgetImpl[] wsrStorageWidgets =
	               wsrProtocolStorageOperations.getStoredElements(groupId, numbers);
	      for(int index =0;index<wsrStorageWidgets.length;index++){
	          wsrProtocolStorageOperations.deleteStoredElement(groupId, 
	                                  wsrStorageWidgets[index].getSequenceNumber());
	      }
	       
	  }

}